<html dir="ltr">
	<head>
		<title>Including Resources</title>
		<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
		<meta content="http://schemas.microsoft.com/intellisense/ie5" name="vs_targetSchema">
		<xml></xml><LINK href="MSDN.css" type="text/css" rel="stylesheet">
		<script language="javascript">
		function openNewWindow(strUrl){window.open(strUrl, '_blank');} // Open the given url in a new window
		</script>
	</head>
	<body class="dtBODY" id="bodyID">
		<div id="nsbanner">
			<div id="bannerrow1">
				<table class="bannerparthead" id="Table1" cellSpacing="0">
					<tr id="hdr">
						<td class="runninghead">NDocBuilder Documentation</td>
						<td class="product"></td>
					</tr>
				</table>
			</div>
			<div id="TitleRow">
				<h1 class="dtH1">NDocBuilder</h1>
			</div>
		</div>
		<div id="nstext">
			<p><h3 class="dtH3" id="Including_Resources">Including Resources</h3>
				Images or additional Html files can be included in the documentation file as resources. 
				The plugin NDocBuilder will includes all files that it locates in the resource directories. These resource directories are defined in the config file of NDocBuilder.<br/>
				For this example we'll use the directory "<i>Documentation/Resources</i>", which is relative to the project folder.<br/>
			</p>
			<ul>
				<li>Extract the project from the <a href="SampleSolution.zip">sample solution</a> and open the solution file "<i>NDocBuilderTestConsoleApp.sln</i>"</li>
				<li>
					Create the folder "<i>Documentation/Resources</i>".<br/>
					<img border="1" src="DocumentationResources.gif"/>
				</li>
				<li>
					Create a jpeg image with your favorite paint program and save it in the "<i>Documentation/Resources</i>" folder as "<i>image.jpg</i>".<br/>
					Add the image to the project.
				</li>
				<li>
					Open the file NamespaceDoc.cs and add <i>&lt;img src="image.jpg"/&gt;</i> between the &lt;summary&gt; tags.
				</li>
				<li>
					Select "<i>Rebuild Solution</i>" from the build menu.<br/>
					This will create the assembly and the Xml documentation.
				</li>
				<li>
					Select "<i>NDocBuilder</i>" from the tools menu.<br/>
					When the plugin is done the NDoc project file and the Chm helpfile have been added to the project.
				</li>
				<li>
					Open the Chm file by double clicking on it from the solution explorer.<br/>
					You will see that the image is shown on the start page.
				</li>
			</ul>
			<p>
				Since all files located in the resource directories are included into the compiled helpfile, you can use this technique to include additional html pages, zip files and/or even javascripts.<br/>
				See "<a href="AlternativeStartpage.htm">Selecting a different start page</a>" how to include extra html files.
			</p>
			<hr>
			<div id="footer">
				<p>
				</p>
				<p>
				</p>
			</div>
		</div>
	</body>
</html>
